/**
 * This file is part of 1genia trampoline
 * Copyright (C) 2007 1genia (contact@1genia.com)
 *
 * This library is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; version 3 of the License. 
 *
 * This library is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Library General Public License for more details. 
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; see the file COPYING.TXT.  If not,
 * write to the Free Software Foundation, Inc., 51 Franklin Street,
 * Fifth Floor, Boston, MA 02110-1301, USA. 
 **/
package com.genia.toolbox.web.portlet.bean.impl;

import org.springframework.util.ObjectUtils;
import org.springframework.util.StringUtils;

import com.genia.toolbox.basics.exception.BundledException;
import com.genia.toolbox.web.portlet.visitor.PortletVisitor;

/**
 * the implementation of a portlet that redirect to an URL via a
 * <code>RequestDispatcher</code>.
 */
public class DispatcherPortlet
    extends AbstractPortlet
{

  /**
   * <code>DispatcherPortlet</code> have no description.
   * 
   * @return <code>null</code>
   */
  @Override
  public String getDescriptionName()
  {
    return null;
  }

  /**
   * the name of the spring controller that will handle this portlet.
   */
  private String url;



  /**
   * Indicates whether some other object is "equal to" this one.
   * 
   * @param obj
   *          the reference object with which to compare.
   * @return <code>true</code> if this object is the same as the obj argument;
   *         <code>false</code> otherwise.
   * @see java.lang.Object#equals(java.lang.Object)
   */
  @Override
  public boolean equals(final Object obj)
  {
    if (!super.equals(obj)) {
      return false;
    }
    if (obj instanceof DispatcherPortlet) {
      final DispatcherPortlet oPortlet = (DispatcherPortlet) obj;
      return ObjectUtils.nullSafeEquals(getUrl(), oPortlet.getUrl());
    }
    return false;
  }



  /**
   * The visit method to use with a <code>PortletVisitor</code>.
   * 
   * @param visitor
   *          the <code>PortletVisitor</code>
   * @throws BundledException
   *           when an error occurred.
   * @see com.genia.toolbox.web.portlet.bean.Portlet#visit(com.genia.toolbox.web.portlet.visitor.PortletVisitor)
   */
  public void visit(final PortletVisitor visitor)
      throws BundledException
  {
    visitor.visitDispatcherPortlet(this);
  }



  /**
   * Returns a hash code value for the object. This method is supported for the
   * benefit of hashtables such as those provided by
   * <code>java.util.Hashtable</code>.
   * 
   * @return a hash code value for this object.
   * @see java.lang.Object#hashCode()
   */
  @Override
  public int hashCode()
  {
    return ObjectUtils.nullSafeHashCode(new Object[] { getAttributes(), getIdentifier(), getUrl() });
  }



  /**
   * getter for the url property.
   * 
   * @return the url
   */
  public String getUrl()
  {
    return url;
  }



  /**
   * setter for the url property.
   * 
   * @param url
   *          the url to set
   */
  public void setUrl(final String url)
  {
    this.url = StringUtils.trimWhitespace(url);
  }

}
